Skip to main content
Minh Nong
💬
0 discussions

[API] web-service

Activity.js

Create Activity

  • Route: /activity
  • Method: POST
  • Body: type, text, createdAt, infoSMS, isSMS, idContact, phone
  • Related API:
    • access: POST /callcenter/${idCallcenter}/activity
  • Return Format:
    • Success: 200 res.json({ success: true, result: activity, calllog: activityResponse.calllog })
    • Failure: 400 { success: false, error: { message: error.message } }

Get Activity

  • Route: /activity/:id
  • Method: GET
  • Params: id
  • Related API:
    • access: GET /callcenter/${idCallcenter}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Update Activity

  • Route: /activity/:id
  • Method: PUT
  • Params: id
  • Body: req.body
  • Related API:
    • access: PUT /callcenter/${idCallcenter}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Activity

  • Route: /activity/:id
  • Method: DELETE
  • Params: id
  • Related API:
    • access: PUT /callcenter/${idCallcenter}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Create Activity (for Contact)

  • Route: /activity
  • Method: POST
  • Body: type, text, createdAt, infoSMS, isSMS, idContact, phone
  • Related API:
    • access: POST /callcenter/${idCallcenter}/activity
  • Return Format:
    • Success: 200 res.json({ success: true, result: activity, calllog: activityResponse.calllog })
    • Failure: 400 { success: false, error: { message: error.message } }

Get Activity by ID

  • Route: /activity/:id
  • Method: GET
  • Params: id
  • Related API:
    • access: GET /callcenter/${idCallcenter}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Update Activity by ID

  • Route: /activity/:id
  • Method: PUT
  • Params: id
  • Body: req.body
  • Related API:
    • access: PUT /callcenter/${idCallcenter}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Activity by ID

  • Route: /activity/:id
  • Method: DELETE
  • Params: id
  • Related API:
    • access: PUT /callcenter/${idCallcenter}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Create Activity for Contact

  • Route: /contact/:idContact/activity
  • Method: POST
  • Params: idContact
  • Body: type, text, createdAt, infoSMS, isSMS
  • Related API:
    • access: POST /callcenter/${idCallcenter}/contact/${idContact}/activity
  • Return Format:
    • Success: 200 res.json({ success: true, result: activity, calllog: activityResponse.calllog })
    • Failure: 400 { success: false, error: { message: error.message } }

Get Activity for Contact by ID

  • Route: /contact/:idContact/activity/:id
  • Method: GET
  • Params: idContact, id
  • Related API:
    • access: GET /callcenter/${idCallcenter}/contact/${idContact}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Update Activity for Contact by ID

  • Route: /contact/:idContact/activity/:id
  • Method: PUT
  • Params: idContact, id
  • Body: req.body
  • Related API:
    • access: PUT /callcenter/${idCallcenter}/contact/${idContact}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Activity for Contact by ID

  • Route: /contact/:idContact/activity/:id
  • Method: DELETE
  • Params: idContact, id
  • Related API:
    • access: PUT /callcenter/${idCallcenter}/contact/${idContact}/activity/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Activities for Contact with Query

  • Route: /contact/:idContact/activities/:query
  • Method: GET
  • Params: idContact, query
  • Related API:
    • access: GET /callcenter/${idCallcenter}/contact/${idContact}/activities?${query}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Activities

  • Route: /activities
  • Method: GET
  • Query: by, all
  • Related API:
    • access: POST /callcenter/${idCallcenter}/activities
  • Return Format:
    • Success: 200 res.json({ success: true, result: list, hasMore, count, mainCount, secondaryCount })
    • Failure: 400 { success: false, error: { message: error.message } }

Download Activities

  • Route: /activities/download
  • Method: GET
  • Query: by, all
  • Related API:
    • access: GET /callcenter/${user.idCallcenter}/contactgroup/${query.idGroup}/contacts
    • access: POST /callcenter/${idCallcenter}/activities
  • Return Format:
    • Success: 200 res.json({ success: true, result: list, hasMore, count, mainCount, secondaryCount })
    • Failure: 400 { success: false, error: { message: error.message } }

Get Activity Count

  • Route: /activities/count
  • Method: GET
  • Query: filter
  • Related API:
    • access: GET /callcenter/${user.idCallcenter}/activities/count
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Summarize Activities

  • Route: /activities/sum
  • Method: GET
  • Query: filter
  • Related API:
    • access: POST /callcenter/${user.idCallcenter}/activities/sum
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data);
    • Failure: 400 { success: false, error: { message: error.message } }

Get Activity Chart

  • Route: /activities/chart
  • Method: GET
  • Query: filter
  • Related API:
    • access: GET /callcenter/${user.idCallcenter}/activities/chart
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Add Tags to Activity

  • Route: /activity/:id/tags
  • Method: POST
  • Params: id
  • Body: req.body
  • Related API:
    • access: POST /callcenter/${idCallcenter}/activity/${id}/tags
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Remove Tags from Activity

  • Route: /activity/:id/tags
  • Method: DELETE
  • Params: id
  • Body: req.body
  • Related API:
    • access: DELETE /callcenter/${idCallcenter}/activity/${id}/tags
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Agent.js

Get All Agents

  • Route: /agents/all
  • Method: GET
  • Params: apikey
  • Query: from, to, timezone, work_start, work_end
  • Body: ``
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/agents/all
  • Return Format:
    • Success: 200 res.json(response.data);
    • Failure: 400 { result: false, data: error.response.data }

Transfer Admin Privileges

  • Route: /agent/admin/:id
  • Method: POST
  • Params: id
  • Query: apikey
  • Body: ``
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/transfer-admin/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Get Agent Roles

  • Route: /agents/roles/:lang
  • Method: GET
  • Params: lang
  • Query: apikey
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/agents/roles/${lang}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false,error: {message: error.message}}

Update User Actions

  • Route: /agent/actions/user/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/user/${id}/actions
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false,error: {message: error.message}}

Get User Actions by Role

  • Route: /agent/actions/user/:id/:role
  • Method: GET
  • Params: id, role
  • Query: apikey
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/user/${user._id}/actions
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false,error: {message: error.message}}

Get Actions for Agents

  • Route: /agents/actions/tenant/:lang
  • Method: GET
  • Params: lang
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/action-user/${lang}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false,error: {message: error.message}}

Get All Roles

  • Route: /roles/
  • Method: GET
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/roles/all
  • Return Format:
    • Success: 200 res.json(error.response.data)
    • Failure: 400 { success: false,error: {message: error.message}}

Get Agent by ID

  • Route: /agent/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/agent/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Update Agent by ID

  • Route: /agent/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/agent/${id}
  • Return Format:
    • Success: 200 {success: true}
    • Failure: 400 { result: false, data: error.response.data }

Update Agent Role

  • Route: /agent/role/:idTenant/:id
  • Method: PUT
  • Params: idTenant, id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${idTenant}/role/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Confirm Agent

  • Route: /confirm/:id
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/confirm/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Revoke Agent Access

  • Route: /agent/revoke/:id
  • Method: POST
  • Params: versionSchema
  • Query: ``
  • Body: ``
  • Related API:
    • Access: POST /api/${versionApi}/revoke
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Get Confirms

  • Route: /confirms
  • Method: GET
  • Params:
  • Query: type
  • Related API:
    • Access: GET /api/${versionApi}/confirms?idCallcenter=${user.idCallcenter}&type=${req.query.type}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Confirm by ID

  • Route: /confirm/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Related API:
    • Access: GET /api/${versionApi}/confirm/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Contact Groups for Agent

  • Route: /agent/:idAgent/contactgroups
  • Method: GET
  • Params: idAgent
  • Query: apikey
  • Body: idCallcenter
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${idCallcenter}/agent/${idAgent}/contactgroups
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Get Agent Status Logs

  • Route: /agent/status/logs
  • Method: GET
  • Params:
  • Query: apikey
  • Body: idCallcenter
  • Related API:
    • Access: GET /callcenter/${idCallcenter}/agent/status/logs
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Get Agent Status Logs by Date

  • Route: /agent/status/logs/date
  • Method: GET
  • Params:
  • Query:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${idCallcenter}/agents/status/logs/date
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Agent Status Count

  • Route: /agent/status/count
  • Method: GET
  • Params:
  • Query: filter
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/agent/status/count
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Api.js

Get All API Keys

  • Route: /api/keys
  • Method: GET
  • Params:
  • Query:
  • Body:
  • Related API:
    • Access: GET /callcenter/${user.idCallcenter}/api/keys
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Create API Key

  • Route: /api/key
  • Method: POST
  • Params:
  • Query:
  • Body: req.body
  • Related API:
    • Access: POST /callcenter/${user.idCallcenter}/api/key
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Update API Key

  • Route: /api/key/:key
  • Method: PUT
  • Params: key
  • Query:
  • Body:
  • Related API:
    • Access: PUT /api/${versionApi}/api/key/${key}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Delete API Key

  • Route: /api/key/:key
  • Method: DELETE
  • Params: key
  • Query:
  • Body:
  • Related API:
    • Access: DELETE /api/${versionApi}/api/key/${key}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Get All Endpoints

  • Route: /api/endpoints
  • Method: GET
  • Params:
  • Query:
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/api/endpoint
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get All Buttons

  • Route: /button/buttons
  • Method: GET
  • Params:
  • Query:
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/clicktocall
  • Return Format:
    • Success: res.status(response.status).json(response.data)
    • Failure: res.status(error.response.status).json(error.response.data);

Create Button

  • Route: /button/button
  • Method: POST
  • Params:
  • Query:
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/clicktocall
  • Return Format:
    • Success: res.status(response.status).json(response.data)
    • Failure: res.status(error.response.status).json(error.response.data);

Update Button

  • Route: /button/button/:id
  • Method: PUT
  • Params: id
  • Query:
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/clicktocall/${id}
  • Return Format:
    • Success: res.status(response.status).json(response.data)
    • Failure: res.status(error.response.status).json(error.response.data);

Delete Button

  • Route: /button/button/:id
  • Method: DELETE
  • Params: id
  • Query:
  • Body:
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/clicktocall/${id}
  • Return Format:
    • Success: res.status(response.status).json(response.data)
    • Failure: res.status(error.response.status).json(error.response.data);

Post Call Log

  • Route: /calllog
  • Method: POST
  • Params:
  • Query:
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/calllog
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Contact.js

Get phone

  • Route: /phone
  • Method: GET
  • Params:
  • Query:
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/phone
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Post Contact

  • Route: /contact
  • Method: POST
  • Params:
  • Query:
  • Body: firstName, lastName, gender, phone, email, birthday
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/contact
    • Access: POST /callcenter/${user.idCallcenter}/contactgroup/${req.body.group}/contacts
    • Access: GET /callcenter/${user.idCallcenter}/contactgroup/${req.body.group}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Post Contacts

  • Route: /contacts
  • Method: POST
  • Params:
  • Query:
  • Body: overwrite
  • Related API:
    • Access: GET /callcenter/${user.idCallcenter}/contactfields/all
    • Access: GET /callcenter/${user.idCallcenter}/contacts
    • Access: POST /callcenter/${user.idCallcenter}/contacts
    • Access: DELETE /callcenter/${user.idCallcenter}/contacts
    • Access: PUT /callcenter/${user.idCallcenter}/contacts
    • Access: GET /callcenter/${user.idCallcenter}/contactgroups/search
    • Access: POST /callcenter/${user.idCallcenter}/contactgroup/${group_id}/contacts
  • Return Format:
    • Success: 200 {success: true,count,duplicate: !overwrite ? duplicateContacts : [],invalid: invalidContactData,columns: columnsName}
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Get Contacts

  • Route: /contacts
  • Method: GET
  • Params:
  • Query:
  • Body: req.body
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contacts
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Delete Contacts

  • Route: /contacts
  • Method: DELETE
  • Params:
  • Query:
  • Body: req.body
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/contacts
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Get Contact

  • Route: /contact/:id
  • Method: GET
  • Params: id
  • Query:
  • Body:
  • Related API:
    • Access: GET /callcenter/${user.idCallcenter}/contact/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Put Contact

  • Route: /contact/:id
  • Method: PUT
  • Params: id
  • Query:
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/contact/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Delete Contact

  • Route: /contact/:id
  • Method: DELETE
  • Params: id
  • Query:
  • Body:
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/contact/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Get Contact Groups

  • Route: /contact/:id/groups
  • Method: GET
  • Params: id
  • Query: req.query
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contact/${id}/groups
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Search Contact

  • Route: /contacts/search
  • Method: POST
  • Params:
  • Query: req.query
  • Body:
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/contacts/search
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

ContactField.js

Post Contact Field

  • Route: /contactfield
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/contactfield
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Contact Field

  • Route: /contactfield/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactfield/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Update Contact Field

  • Route: /contactfield/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/contactfield/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Contact Field

  • Route: /contactfield/:id
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/contactfield/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get All Contact Fields

  • Route: /contactfields/all
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactfields/all
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { result: false, data: error.response.data }

Get All Contact Fields

  • Route: /contactfields
  • Method: GET
  • Params:
  • Query: req.query
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactfields
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get All Contact Fields

  • Route: /contactfields/all
  • Method: GET
  • Params:
  • Query:
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactfields/all
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

ContactGroup.js

Post Contact Group

  • Route: /contactgroup
  • Method: POST
  • Params:
  • Query:
  • Body: name, description, maingroup
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get All Contact Groups

  • Route: /contactgroups
  • Method: GET
  • Params:
  • Query: req.query
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroups
  • Return Format:
    • Success: 200 res.json(error.response.data)
    • Failure: 400 { success: false, error: { message: error.message } }
  • Route: /contactgroups/search
  • Method: GET
  • Params:
  • Query: req.query
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroups/search
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Contact Group

  • Route: /contactgroup/:id
  • Method: GET
  • Params: id
  • Query:
  • Body:
  • Related API:
    • Access: GET /callcenter/${user.idCallcenter}/contactgroup/${id}
  • Return Format:
    • Success: 200 res.json(response.data);
    • Failure: 400 { success: false, error: { message: error.message } }

Update Contact Group

  • Route: /contactgroup/:id
  • Method: PUT
  • Params: id
  • Query:
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Contact Group

  • Route: /contactgroup/:id
  • Method: DELETE
  • Params: id
  • Query:
  • Body:
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Contact Group Contacts

  • Route: /contactgroup/:id/contacts
  • Method: GET
  • Params: id
  • Query: req.query
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}/contacts
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Add Contact Group Contacts

  • Route: /contactgroup/:id/contacts
  • Method: POST
  • Params: id
  • Query:
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}/contacts
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Contact Group Contacts

  • Route: /contactgroup/:id/contacts
  • Method: DELETE
  • Params: id
  • Query:
  • Body: req.body
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}/contacts
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }
  • Route: /contactgroup/:id/contacts/search
  • Method: GET
  • Params: id
  • Query:
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}/contacts/search
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Contact Group Agents

  • Route: /contactgroup/:id/agents
  • Method: GET
  • Params: id
  • Query:
  • Body:
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}/agents
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Add Contact Group Agents

  • Route: /contactgroup/:id/agents
  • Method: POST
  • Params: id
  • Query:
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}/agents
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Contact Group Agents

  • Route: /contactgroup/:id/agents
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroup/${id}/agents
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

POST groups

  • Route: /agentgroup/:idAgent/groups
  • Method: POST
  • Params: idAgent
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/agentgroup/${idAgent}/groups
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get groups

  • Route: agentgroup/:idAgent/groups
  • Method: GET
  • Params: idAgent
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/agentgroup/${idAgent}/groups
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Add groups

  • Route: /contactgroups/agents
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroups/agents
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete groups

  • Route: /contactgroups/agents
  • Method: DELETE
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/contactgroups/agents
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

ExportContact.js

Export Contact

  • Route: /exports
  • Method: POST
  • Params: ``
  • Query: title, nameSheet, range, id_sheet, id, isFilter, direction, status, timeFilter, name, all, lang
  • Body: access_token, user_name, email, subject, content
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/exportcontact
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

GroupField.js

Post Group Field

  • Route: /groupfield
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /${versionApi}/callcenter/${user.idCallcenter}/groupfield
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Group Field

  • Route: /groupfield/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/groupfield/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Update Group Field

  • Route: /groupfield/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/groupfield/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Group Field

  • Route: /groupfield/:id
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/groupfield/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get All Group Fields

  • Route: /groupfields/all

  • Method: GET

  • Params: ``

  • Query: ``

  • Body: ``

  • Related API:

    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/groupfields/all
  • Return Format:

    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

    Integration.js

Get Contact by Phone in HubSpot Integration

  • Route: /hubspot/contact/:phone
  • Method: GET
  • Params: phone
  • Query: ``
  • Body: ``
  • Related API:
    • Integration: GET /api/hubspot/contacts/search
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Create Contact in HubSpot Integration

  • Route: /hubspot/contact
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Integration: POST /api/hubspot/contact
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Get Engagement by ID in HubSpot Integration

  • Route: /hubspot/engagement/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/hubspot/engagement/${id}
  • Return Format:
    • Success: 200 res.json({ success: true, result: response })
    • Failure: 400 res.json({ success: false, error: { message: error.message } })

Update Engagement by ID in HubSpot Integration

  • Route: /hubspot/engagement/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Integration: GET /api/hubspot/engagement/${id}
    • Integration: PUT /api/hubspot/engagement/${id}
  • Return Format:
    • Success: 200 res.json({ success: true, result: response })
    • Failure: 400 res.json({ success: false, error: { message: error.message } })

Get Recent Deals in HubSpot Integration

  • Route: /hubspot/deals/recent
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: ``
  • Related API:
    • Integration: GET /api/hubspot/deals/recent
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Send SMS via Vietguys

  • Route: /vietguy/
  • Method: GET
  • Params: ``
  • Query: sms, phone
  • Body: ``
  • Related API:
    • Vietguys: POST https://cloudsms4.vietguys.biz:4438/api/index.php
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Send SMS via Nexmo

  • Route: /nexmo/
  • Method: GET
  • Params: ``
  • Query: sms, phone
  • Body: ``
  • Related API:
    • Integration: GET /api/nexmo/sms
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Send SMS via Infobip

  • Route: /infobip/
  • Method: POST
  • Params: ``
  • Query: host
  • Body: ``
  • Related API:
    • Integration: POST /api/integrator/send_sms_infobip
  • Return Format:
    • Success: 200 { success: true, result }
    • Failure: 400 { success: false, error: error}

Get Call Center Member by Phone via VinhTinh

  • Route: /vinhtin/:phone
  • Method: GET
  • Params: phone
  • Query: ``
  • Body: ``
  • Related API:
    • VinhTinh: GET http://113.161.25.2:44771/POSService.svc/GetCallCenterMember?Phone=${phone}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Push Brandname OTP via FPT

  • Route: /fpt/push-brandname-otp
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: brandname
  • Related API:
    • FPT Integration: POST /api/fpt/push-brandname-otp
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Get Investor by Phone via Mio

  • Route: /mio/get-investor-by-phone
  • Method: GET
  • Params: req.query
  • Query: ``
  • Body: ``
  • Related API:
    • Mio Integration: GET /api/mio/get-investor-by-phone
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Get All Customers from SAPO

  • Route: /sapo/customers
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
    • SAPO Integration: GET /api/sapo/customers
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Get All Orders from SAPO

  • Route: /sapo/orders
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: ``
  • Related API:
    • SAPO Integration: GET /api/sapo/orders
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Get Account by ID from SAPO

  • Route: /sapo/accounts/:id
  • Method: GET
  • Params: id
  • Query: req.query
  • Body: ``
  • Related API:
    • SAPO Integration: GET /api/sapo/accounts/${id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Search Integrator

  • Route: /integrator/search
  • Method: GET
  • Params: ``
  • Query: host, phone
  • Body: ``
  • Related API:
    • Integrator: POST /api/integrator/${endpoint_name}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Endpoint Integration

  • Route: /integrator/:endpoint
  • Method: POST
  • Params: ``
  • Query: host
  • Body: ``
  • Related API:
    • Integrator: POST /api/integrator/${endpoint_name}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Custom Integration Endpoint

  • Route: /integration/:template_name/endpoint/:endpoint_name
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Custom Integration: POST /api/integrator/${template_name}/endpoint/${endpoint_name}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: error}

Send SMS via eSMS

  • Route: /esms/
  • Method: POST
  • Params: ``
  • Query: host
  • Body: req.body
  • Related API:
    • eSMS Integration: POST /api/integrator/send_sms_esms?host=${host}
  • Return Format:
    • Success: 200 { success: true, result:response.data }
    • Failure: 400 { success: false, error: error}

Integrations.js

Get All Templates

  • Route: /integrations/templates
  • Method: GET
  • Params: req.query
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/integration/templates
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Create Template

  • Route: /integrations/template
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/integration/template
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Delete Template

  • Route: /integrations/template
  • Method: DELETE
  • Params: ``
  • Query: id
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/integration/template/${req.query.id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Get All Endpoints

  • Route: /integrations/endpoints
  • Method: GET
  • Params: req.query
  • Query: integrator
  • Body: ``
  • Related API:
    • Access: GET /${versionApi}/integration/endpoints
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Create Endpoint

  • Route: /integrations/endpoint
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /${versionApi}/integration/endpoint
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Update Endpoint

  • Route: /integrations/endpoint
  • Method: PUT
  • Params: ``
  • Query: id
  • Body: req.body
  • Related API:
    • Access: PUT /${versionApi}/integration/endpoint/${req.query.id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Delete Endpoint

  • Route: /integrations/endpoint
  • Method: DELETE
  • Params: ``
  • Query: id
  • Body: ``
  • Related API:
    • Access: DELETE /${versionApi}/integration/endpoint/${req.query.id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Create Integrator

  • Route: /integrations/integrator
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /${versionApi}/callcenter/${user.idCallcenter}/integrator
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Get All Integrators

  • Route: /integrations/integrator
  • Method: GET
  • Params: ``
  • Query: integrator
  • Body: ``
  • Related API:
    • Access: GET /${versionApi}/integrators
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Update Integrator

  • Route: /integrations/integrator
  • Method: PUT
  • Params: ``
  • Query: id
  • Body: req.body
  • Related API:
    • Access: PUT /${versionApi}/integrator/${req.query.id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Delete Integrator

  • Route: /integrations/integrator
  • Method: DELETE
  • Params: ``
  • Query: id
  • Body: ``
  • Related API:
    • Access: DELETE /${versionApi}/integrator/${req.query.id}
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Invite.js

Post Invitation

  • Route: /invitation
  • Method: POST
  • Params: ``
  • Query: host
  • Body: email, idSip, actions, roleID, idsGroup, fullName, mailHost, mailPort, mailUser, mailPassword, mailEmail, mailAdmin, idTeam
  • Related API:
    • Access: POST /api/${versionApi}/confirm
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Post Log

  • Route: /log
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/log
  • Return Format:
    • Success: 200 res.json({ success: true })
    • Failure: 400 res.json({ success: false, error: { message: error.message } })

MailService.js

Get Mail Service

  • Route: /mailservice
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Update Mail Service

  • Route: /mailservice
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: mailHost, mailPort, mailUser, mailPassword, mailEmail, mailTest
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.status(error.response.status).json(error.response.data)

Record.js

Get All Record

  • Route: /record
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/record
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get CDR Record

  • Route: /record/cdr/:uuid
  • Method: GET
  • Params: uuid
  • Query: req.query
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/record/cdr/:uuid
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Setting.js

Post Setting

  • Route: /setting
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/setting
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Get Setting

  • Route: /setting
  • Method: GET
  • Params: ``
  • Query: type
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/setting
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

Delete Setting

  • Route: /setting
  • Method: DELETE
  • Params: ``
  • Query: type
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/setting
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 { success: false, error: { message: error.message } }

SipAccount.js

Post Sip Account

  • Route: /sipaccount
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/sipaccount
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Get All Sip Accounts

  • Route: /sipaccounts/all
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/sipaccounts/all
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.json(error.response.data)

Create Sip Accounts

  • Route: /sipaccounts
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: list
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/sipaccount
  • Return Format:
    • Success: 200 { success: true,result }
    • Failure: 400 res.json(error.response.data)

Get Sip Account

  • Route: /sipaccount/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/sipaccount/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Update Sip Account

  • Route: /sipaccount/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: data
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/sipaccount/${id}
  • Return Format:
    • Success: 200 { success: true}
    • Failure: 400 res.json(error.response.data)

Delete Sip Account

  • Route: /sipaccount/:id
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/sipaccount/${id}
  • Return Format:
    • Success: 200 { success: true }
    • Failure: 400 res.json({ success: false })

Team.js

Post Team

  • Route: /team
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/team
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Get All Teams

  • Route: /teams/all
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/teams/all
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.json(error.response.data)

Get Team

  • Route: /team/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/team/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Update Team

  • Route: /team/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/team/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Delete Team

  • Route: /team/:id
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/team/${id}
  • Return Format:
    • Success: 200 res.json({ success: true })
    • Failure: 400 res.json({ success: false })

Template.js

Post Template

  • Route: /template
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/callcenter/${user.idCallcenter}/template
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Update Template

  • Route: /template/:id
  • Method: PUT
  • Params: id
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: PUT /api/${versionApi}/callcenter/${user.idCallcenter}/template/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Delete Template

  • Route: /template/:id
  • Method: DELETE
  • Params: id
  • Query: ``
  • Body: ``
  • Related API:
    • Access: DELETE /api/${versionApi}/callcenter/${user.idCallcenter}/template/${id}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Get All Templates

  • Route: /templates/all
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/callcenter/${user.idCallcenter}/templates/all
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

User.js

Get User Session

  • Route: /session
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
  • Return Format:
    • Success: 200 { success: true, result: { ...user, status: "online"} }
    • Failure: 400 res.json(error.response.data)

Post Survey

  • Route: /survey
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
  • Return Format:
    • Success: 200 res.json(resp);
    • Failure: 400 res.json(error.response.data)

Post Survey Form

  • Route: /survey/form
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
  • Return Format:
    • Success: 200 { success: true }
    • Failure: 400 res.json(error.response.data)

offline

  • Route: /offline
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
  • Return Format:
    • Success: 200 {success: true}
    • Failure: 400 res.json(error.response.data)

Signout

  • Route: /user/signout
  • Method: GET
  • Header: x-sessiontoken
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
  • Return Format:
    • Success: 200 {success: true}
    • Failure: 400 res.json(error.response.data)

ForgetCallcenterName.js

Forget Callcenter Name

  • Route: /forgetcallcentername
  • Method: POST
  • Params: ``
  • Query: host
  • Body: email
  • Related API:
    • Access: POST /api/${versionApi}/confirm
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

ForgetPassword.js

Forget Password

  • Route: /forgetpassword
  • Method: POST
  • Params: ``
  • Query: host
  • Body: email
  • Related API:
    • Access: POST /api/${versionApi}/confirm
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Reset Password

  • Route: /forgetpassword/:token
  • Method: PUT
  • Params: token
  • Query: ``
  • Body: password
  • Related API:
    • Access: PUT /api/${versionApi}/reset-password/${token}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Invite.js

Invitation

  • Route: /invitation/:token
  • Method: POST
  • Params: token
  • Query: ``
  • Body: password
  • Related API:
    • Access: POST /api/${versionApi}/invitation/${token}
  • Return Format:
    • Success: 200 res.send(response.data)
    • Failure: 400 res.json(error.response.data)

MailService.js

Mail

  • Route: /mail/:token
  • Method: PUT
  • Params: token
  • Query: ``
  • Body: ``
  • Related API:
    • Access: PUT /api/${versionApi}/mail/${token}
  • Return Format:
    • Success: 200 res.json(response.data)
    • Failure: 400 res.json(error.response.data)

Notify.js

Notify

  • Route: /reminder
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: idCallcenter, idContact, idReminder, remindedAgentId, reminder
  • Related API:
  • Return Format:
    • Success: 200 res.json({success: true})
    • Failure: 400 { success: false, error: { message: error.message } }

PrivacyPolicy.js

Privacy Policy

  • Route: /privacypolicy
  • Method: GET
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/privacypolicy
  • Return Format:
    • Success: 200 { success: true,result: privacyPolicy}
    • Failure: 400 res.json(error.response.data)

User.js

User

  • Route: /signup
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: password, token
  • Related API:
    • Access: POST /api/${versionApi}/signup
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.json(error.response.data)

Signout

  • Route: /signout
  • Method: GET
  • Header: x-sessiontoken
  • Params: ``
  • Query: ``
  • Body: ``
  • Related API:
  • Return Format:
    • Success: 200 kc.logoutUrl(redirectUrl)
    • Failure: 400 res.json(error.response.data)

Confirm

  • Route: /confirm
  • Method: POST
  • Params: req.query
  • Query: host
  • Body: email, name
  • Related API:
    • Access: POST /api/${versionApi}/confirm
  • Return Format:
    • Success: 200 res.send(response.data)
    • Failure: 400 res.json(error.response.data)

Confirm

  • Route: /confirm/:token
  • Method: GET
  • Params: token
  • Query: ``
  • Body: ``
  • Related API:
    • Access: GET /api/${versionApi}/confirm/:token
  • Return Format:
    • Success: 200 res.status(response.status).json(response.data)
    • Failure: 400 res.json(error.response.data)

Destroy

  • Route: /destroy
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: req.body
  • Related API:
    • Access: POST /api/${versionApi}/destroy
  • Return Format:
    • Success: 200 res.send(response.data)
    • Failure: 400 res.json(error.response.data)